package com.ant.annotation;

import java.lang.annotation.*;

/**
 * Web日志注解
 * 
 * 用于标记需要记录详细日志的方法
 * 配合WebLogAspect切面类使用，自动记录方法的调用信息
 * 包括请求参数、响应结果、执行时间等详细信息
 * 
 * @Auther: 灏
 * @Date: 2025/6/1 - 06 - 01 - 17:19
 * @Description: com.ant.infrastructure.annotation
 * @version: 1.0
 */

@Retention(RetentionPolicy.RUNTIME)  // 注解在运行时保留，可以通过反射获取
@Target({ElementType.METHOD})        // 注解只能用于方法
@Documented                          // 注解会被包含在JavaDoc中
public @interface WebLog {
    
    /**
     * 日志描述信息
     * 
     * 用于在日志中显示方法的业务描述
     * 便于开发人员理解方法的用途
     * 
     * @return 描述信息，默认为空字符串
     **/
    String description() default "";
}
